Crate opcua_types [−] [src]
Contains data types and enumerations for OPC UA.
- All of the built-in data types described in OPC Part 6 Chapter 5 that are encodable
- All of the standard data types described in OPC Part 3 Chapter 8 (if not covered by 1.)
- Autogenerated data types and request / responses as described in OPC Part 4
Modules
| constants | |
| profiles |
Contains constants recognized by OPC UA clients and servers to describe various protocols and profiles used during communication and encryption. |
Structs
| ActivateSessionRequest |
Activates a session with the server. |
| ActivateSessionResponse |
Activates a session with the server. |
| AddNodesItem |
A request to add a node to the server address space. |
| AddNodesRequest |
Adds one or more nodes to the server address space. |
| AddNodesResponse |
Adds one or more nodes to the server address space. |
| AddNodesResult |
A result of an add node operation. |
| AddReferencesItem |
A request to add a reference to the server address space. |
| AddReferencesRequest |
Adds one or more references to the server address space. |
| AddReferencesResponse |
Adds one or more references to the server address space. |
| AggregateConfiguration | |
| AggregateFilter | |
| AggregateFilterResult | |
| Annotation | |
| AnonymousIdentityToken |
A token representing an anonymous user. |
| ApplicationDescription |
Describes an application and how to find it. |
| Argument |
An argument for a method. |
| AttributeOperand | |
| BrowseDescription |
A request to browse the the references from a node. |
| BrowseNextRequest |
Continues one or more browse operations. |
| BrowseNextResponse |
Continues one or more browse operations. |
| BrowsePath |
A request to translate a path into a node id. |
| BrowsePathResult |
The result of a translate opearation. |
| BrowsePathTarget |
The target of the translated path. |
| BrowseRequest |
Browse the references for one or more nodes from the server address space. |
| BrowseResponse |
Browse the references for one or more nodes from the server address space. |
| BrowseResult |
The result of a browse operation. |
| BuildInfo | |
| ByteString |
A sequence of octets. |
| CallMethodRequest | |
| CallMethodResult | |
| CallRequest | |
| CallResponse | |
| CancelRequest |
Cancels an outstanding request. |
| CancelResponse |
Cancels an outstanding request. |
| ChannelSecurityToken |
The token that identifies a set of keys for an active secure channel. |
| CloseSecureChannelRequest |
Closes a secure channel. |
| CloseSecureChannelResponse |
Closes a secure channel. |
| CloseSessionRequest |
Closes a session with the server. |
| CloseSessionResponse |
Closes a session with the server. |
| ComplexNumberType | |
| ContentFilter | |
| ContentFilterElement | |
| ContentFilterElementResult | |
| ContentFilterResult | |
| CreateMonitoredItemsRequest | |
| CreateMonitoredItemsResponse | |
| CreateSessionRequest |
Creates a new session with the server. |
| CreateSessionResponse |
Creates a new session with the server. |
| CreateSubscriptionRequest | |
| CreateSubscriptionResponse | |
| DataChangeFilter | |
| DataChangeNotification | |
| DataTypeAttributes |
The attributes for a data type node. |
| DataValue |
Data type ID 23 |
| DateTime |
Data type ID 13 Holds a date/time broken down into constituent parts |
| DeleteAtTimeDetails | |
| DeleteEventDetails | |
| DeleteMonitoredItemsRequest | |
| DeleteMonitoredItemsResponse | |
| DeleteNodesItem |
A request to delete a node to the server address space. |
| DeleteNodesRequest |
Delete one or more nodes from the server address space. |
| DeleteNodesResponse |
Delete one or more nodes from the server address space. |
| DeleteRawModifiedDetails | |
| DeleteReferencesItem |
A request to delete a node from the server address space. |
| DeleteReferencesRequest |
Delete one or more references from the server address space. |
| DeleteReferencesResponse |
Delete one or more references from the server address space. |
| DeleteSubscriptionsRequest | |
| DeleteSubscriptionsResponse | |
| DiagnosticInfo |
Data type ID 25 |
| DiscoveryConfiguration |
A base type for discovery configuration information. |
| DoubleComplexNumberType | |
| EUInformation | |
| ElementOperand | |
| EndpointConfiguration | |
| EndpointDescription |
The description of a endpoint that can be used to access a server. |
| EndpointUrlListDataType | |
| EnumValueType |
A mapping between a value of an enumerated type and a name and description. |
| EventFieldList | |
| EventFilter | |
| EventFilterResult | |
| EventNotificationList | |
| ExpandedNodeId |
A NodeId that allows the namespace URI to be specified instead of an index. Data type ID 18 |
| ExtensionObject |
A structure that contains an application specific data type that may not be recognized by the receiver. Data type ID 22 |
| FilterOperand | |
| FindServersOnNetworkRequest | |
| FindServersOnNetworkResponse | |
| FindServersRequest |
Finds the servers known to the discovery server. |
| FindServersResponse |
Finds the servers known to the discovery server. |
| GetEndpointsRequest |
Gets the endpoints used by the server. |
| GetEndpointsResponse |
Gets the endpoints used by the server. |
| Guid |
A 16 byte value that can be used as a globally unique identifier. Data type ID 14 |
| HistoryData | |
| HistoryEvent | |
| HistoryEventFieldList | |
| HistoryReadDetails | |
| HistoryReadRequest | |
| HistoryReadResponse | |
| HistoryReadResult | |
| HistoryReadValueId | |
| HistoryUpdateDetails | |
| HistoryUpdateRequest | |
| HistoryUpdateResponse | |
| HistoryUpdateResult | |
| IssuedIdentityToken |
A token representing a user identified by a WS-Security XML token. |
| LiteralOperand | |
| LocalizedText |
Human readable text with an optional locale identifier Data type ID 21 |
| MdnsDiscoveryConfiguration |
The discovery information needed for mDNS registration. |
| MethodAttributes |
The attributes for a method node. |
| ModelChangeStructureDataType | |
| ModifyMonitoredItemsRequest | |
| ModifyMonitoredItemsResponse | |
| ModifySubscriptionRequest | |
| ModifySubscriptionResponse | |
| MonitoredItemCreateRequest | |
| MonitoredItemCreateResult | |
| MonitoredItemModifyRequest | |
| MonitoredItemModifyResult | |
| MonitoredItemNotification | |
| MonitoringFilter | |
| MonitoringFilterResult | |
| MonitoringParameters | |
| MultiDimensionArray | |
| NetworkGroupDataType | |
| NodeAttributes |
The base attributes for all nodes. |
| NodeId |
An identifier for a node in the address space of an OPC UA Server. |
| NodeReference | |
| NodeTypeDescription | |
| NotificationData | |
| NotificationMessage | |
| ObjectAttributes |
The attributes for an object node. |
| ObjectTypeAttributes |
The attributes for an object type node. |
| OpenSecureChannelRequest |
Creates a secure channel with a server. |
| OpenSecureChannelResponse |
Creates a secure channel with a server. |
| OptionSet |
This abstract Structured DataType is the base DataType for all DataTypes representing a bit mask. |
| ParsingResult | |
| ProgramDiagnosticDataType | |
| PublishRequest | |
| PublishResponse | |
| QualifiedName |
A numeric identifier for a error or condition that is associated with a value or an operation. Data type ID 19 A name qualified by a namespace. Data type ID 20 |
| QueryDataDescription | |
| QueryDataSet | |
| QueryFirstRequest | |
| QueryFirstResponse | |
| QueryNextRequest | |
| QueryNextResponse | |
| Range | |
| ReadAtTimeDetails | |
| ReadEventDetails | |
| ReadProcessedDetails | |
| ReadRawModifiedDetails | |
| ReadRequest | |
| ReadResponse | |
| ReadValueId | |
| ReferenceDescription |
The description of a reference. |
| ReferenceTypeAttributes |
The attributes for a reference type node. |
| RegisterNodesRequest |
Registers one or more nodes for repeated use within a session. |
| RegisterNodesResponse |
Registers one or more nodes for repeated use within a session. |
| RegisterServer2Request | |
| RegisterServer2Response | |
| RegisterServerRequest |
Registers a server with the discovery server. |
| RegisterServerResponse |
Registers a server with the discovery server. |
| RegisteredServer |
The information required to register a server with a discovery server. |
| RelativePath |
A relative path constructed from reference types and browse names. |
| RelativePathElement |
An element in a relative path. |
| RepublishRequest | |
| RepublishResponse | |
| RequestHeader | |
| ResponseHeader | |
| SamplingIntervalDiagnosticsDataType | |
| SemanticChangeStructureDataType | |
| ServerDiagnosticsSummaryDataType | |
| ServerOnNetwork | |
| ServiceCounterDataType | |
| ServiceFault |
The response returned by all services when there is a service level error. |
| SessionDiagnosticsDataType | |
| SessionSecurityDiagnosticsDataType | |
| SetMonitoringModeRequest | |
| SetMonitoringModeResponse | |
| SetPublishingModeRequest | |
| SetPublishingModeResponse | |
| SetTriggeringRequest | |
| SetTriggeringResponse | |
| SignatureData |
A digital signature. |
| SignedSoftwareCertificate |
A software certificate with a digital signature. |
| SimpleAttributeOperand | |
| StatusChangeNotification | |
| StatusResult | |
| SubscriptionAcknowledgement | |
| SubscriptionDiagnosticsDataType | |
| TimeZoneDataType | |
| TransferResult | |
| TransferSubscriptionsRequest | |
| TransferSubscriptionsResponse | |
| TranslateBrowsePathsToNodeIdsRequest |
Translates one or more paths in the server address space. |
| TranslateBrowsePathsToNodeIdsResponse |
Translates one or more paths in the server address space. |
| TrustListDataType | |
| UAString |
A UTF-8 encoded sequence of Unicode characters. |
| UnregisterNodesRequest |
Unregisters one or more previously registered nodes. |
| UnregisterNodesResponse |
Unregisters one or more previously registered nodes. |
| UserIdentityToken |
A base type for a user identity token. |
| UserNameIdentityToken |
A token representing a user identified by a user name and password. |
| UserTokenPolicy |
Describes a user token that can be used with a server. |
| ValueChangeFilter | |
| VariableAttributes |
The attributes for a variable node. |
| VariableTypeAttributes |
The attributes for a variable type node. |
| ViewAttributes |
The attributes for a view node. |
| ViewDescription |
The view to browse. |
| WriteRequest | |
| WriteResponse | |
| WriteValue | |
| X509IdentityToken |
A token representing a user identified by an X509 certificate. |
| XVType |
Enums
| ApplicationType | |
| AttributeId | |
| BrowseDirection | |
| DataChangeTrigger | |
| DataTypeId | |
| ExtensionObjectEncoding |
Enumeration that holds the kinds of encoding that an ExtensionObject data may be encoded with. |
| FilterOperator | |
| Identifier |
The kind of identifier, numeric, string, guid or byte |
| MessageSecurityMode |
The MessageSecurityMode is an enumeration that specifies what security should be applied to messages exchanges during a Session. |
| MethodId | |
| MonitoringMode | |
| NodeClass | |
| ObjectId | |
| ObjectTypeId | |
| ReferenceTypeId | |
| SecurityTokenRequestType | |
| StatusCode | |
| TimestampsToReturn | |
| UserTokenType |
ONLY complex service specific data types go in this file |
| VariableId | |
| VariableTypeId | |
| Variant |
A Variant holds all primitive types, including single and multi dimensional arrays and data values. Boxes are used for more complex types to keep the size of this enum down a bit. |
Constants
| WRITE_MASK_ACCESS_LEVEL |
Indicates if the AccessLevel Attribute is writable. |
| WRITE_MASK_ARRAY_DIMENSTIONS |
Indicates if the ArrayDimensions Attribute is writable. |
| WRITE_MASK_BROWSE_NAME |
Indicates if the BrowseName Attribute is writable. |
| WRITE_MASK_CONTAINS_NO_LOOPS |
Indicates if the ContainsNoLoops Attribute is writable. |
| WRITE_MASK_DATA_TYPE |
Indicates if the DataType Attribute is writable. |
| WRITE_MASK_DESCRIPTION |
Indicates if the Description Attribute is writable. |
| WRITE_MASK_DISPLAY_NAME |
Indicates if the DisplayName Attribute is writable. |
| WRITE_MASK_EVENT_NOTIFIER |
Indicates if the EventNotifier Attribute is writable. |
| WRITE_MASK_EXECUTABLE |
Indicates if the Executable Attribute is writable. |
| WRITE_MASK_HISTORIZING |
Indicates if the Historizing Attribute is writable. |
| WRITE_MASK_INVERSE_NAME |
Indicates if the InverseName Attribute is writable. |
| WRITE_MASK_IS_ABSTRACT |
Indicates if the IsAbstract Attribute is writable. |
| WRITE_MASK_MINIMUM_SAMPLING_INTERVAL |
Indicates if the MinimumSamplingInterval Attribute is writable. |
| WRITE_MASK_NODE_CLASS |
Indicates if the NodeClass Attribute is writable. |
| WRITE_MASK_NODE_ID |
Indicates if the NodeId Attribute is writable. |
| WRITE_MASK_SYMMETRIC |
Indicates if the Symmetric Attribute is writable. |
| WRITE_MASK_USER_ACCESS_LEVEL |
Indicates if the UserAccessLevel Attribute is writable. |
| WRITE_MASK_USER_EXECUTABLE |
Indicates if the UserExecutable Attribute is writable. |
| WRITE_MASK_USER_WRITE_MASK |
Indicates if the UserWriteMask Attribute is writable. |
| WRITE_MASK_VALUE_FOR_VARIABLE_TYPE |
Indicates if the Value Attribute is writable for a VariableType. It does not apply for Variables since this is handled by the AccessLevel and UserAccessLevel Attributes for the Variable. For Variables this bit shall be set to 0. |
| WRITE_MASK_VALUE_RANK |
Indicates if the ValueRank Attribute is writable. |
| WRITE_MASK_WRITE_MASK |
Indicates if the WriteMask Attribute is writable. |
Traits
| BinaryEncoder |
OPC UA Binary Encoding interface. Anything that encodes to binary must implement this. It provides functions to calculate the size in bytes of the struct (for allocating memory), encoding to a stream and decoding from a stream. |
| MessageInfo |
Implemented by messages |
Functions
| byte_len_array |
Calculates the length in bytes of an array of encoded type |
| endtimes_chrono |
The OPC UA endtimes - Dec 31 9999 23:59:59 i.e. the date after which dates are returned as MAX_INT64 ticks Spec doesn't say what happens in the last second before midnight... |
| epoch_chrono |
The OPC UA epoch - Jan 1 1601 00:00:00 |
| is_opc_ua_binary_url | |
| process_decode_io_result |
Converts an IO encoding error (and logs when in error) into an EncodingResult |
| process_encode_io_result |
Converts an IO encoding error (and logs when in error) into an EncodingResult |
| read_array |
Reads an array of the encoded type from a stream, preserving distinction between null array and empty array |
| read_bytes |
Reads an array of bytes from the stream |
| read_f32 |
Read a 32-bit precision value from the stream |
| read_f64 |
Read a 64-bit precision from the stream |
| read_i16 |
Read an signed 16-bit value from the stream |
| read_i32 |
Read a signed 32-bit value from the stream |
| read_i64 |
Read a signed 64-bit value from the stream |
| read_u8 |
Read an unsigned byte from the stream |
| read_u16 |
Read an unsigned 16-bit value from the stream |
| read_u32 |
Read an unsigned 32-bit value from the stream |
| read_u64 |
Read an unsigned 64-bit value from the stream |
| url_matches_except_host |
Test if the two urls match except for the hostname. Can be used by a server whose endpoint doesn't exactly match the incoming connection, e.g. 127.0.0.1 vs localhost. |
| write_array |
Write an array of the encoded type to stream, preserving distinction between null array and empty array |
| write_f32 |
Writes a 32-bit precision value to the stream |
| write_f64 |
Writes a 64-bit precision value to the stream |
| write_i16 |
Writes a signed 16-bit value to the stream |
| write_i32 |
Writes a signed 32-bit value to the stream |
| write_i64 |
Writes a signed 64-bit value to the stream |
| write_u8 |
Writes an unsigned byte to the stream |
| write_u16 |
Writes an unsigned 16-bit value to the stream |
| write_u32 |
Writes an unsigned 32-bit value to the stream |
| write_u64 |
Writes an unsigned 64-bit value to the stream |
Type Definitions
| Boolean |
A two-state logical value (true or false). Data type ID 1 |
| Byte |
An integer value between 0 and 255. Data type ID 3 |
| Double |
An IEEE double precision (64 bit) floating point value. Data type ID 11 |
| Duration |
This Simple DataType is a Double that defines an interval of time in milliseconds (fractions can be used to define sub-millisecond values). Negative values are generally invalid but may have special meanings where the Duration is used. Duration = 290, |
| EncodingResult | |
| Float |
An IEEE single precision (32 bit) floating point value. Data type ID 10 |
| Index |
This primitive data type is a UInt32 that identifies an element of an array. |
| Int16 |
An integer value between −32 768 and 32 767. Data type ID 4 |
| Int32 |
An integer value between −2 147 483 648 and 2 147 483 647. Data type ID 6 |
| Int64 |
An integer value between −9 223 372 036 854 775 808 and 9 223 372 036 854 775 807 Data type ID 8 |
| IntegerId |
This primitive data type is a UInt32 that is used as an identifier, such as a handle. All values, except for 0, are valid. IntegerId = 288, |
| SByte |
An integer value between −128 and 127. Data type ID 2 |
| UInt16 |
An integer value between 0 and 65 535. Data type ID 5 |
| UInt32 |
An integer value between 0 and 4 294 967 295. Data type ID 7 |
| UInt64 |
An integer value between 0 and 18 446 744 073 709 551 615. Data type ID 9 |
| UtcTime |
UtcTime = 294, |
| XmlElement |
An XML element. Data type ID 16 |